/*
 * Copyright (c) 2012, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.bmi.gwt.mi.shared.communication.var;

import org.bmi.gwt.mi.shared.MiProxy;
import org.bmi.gwt.mi.shared.annotations.Protected;

/**
 * The element returned by a proxy method. The value of such element can't be
 * determined before it's real execution.
 * 
 * This class implements {@link MiProxy}, so it should be treated as a proxy
 * object, it's indeed a proxy to the returned element of a proxy method.
 * 
 * @author marco.tamburelli@gmail.com
 * @param <T> The expected type of element to be returned by the target object
 *        method.
 */
@Protected
public class ReturnVar<T> implements MiProxy, Var
{
	private String returnId;
	private String jsni;

	/**
	 * Default constructor to enable the serialization.
	 */
	public ReturnVar()
	{}

	/**
	 * Constructor which enables to provide a type by a JSNI signature.
	 * 
	 * @param jsni The JSNI representation of the type this class represent.
	 */
	public ReturnVar(String jsni)
	{
		this.jsni = jsni;
	}

	public String getReturnId()
	{
		return this.returnId;
	}

	public void setReturnId(String returnId)
	{
		this.returnId = returnId;
	}

	public String getJsni()
	{
		return jsni;
	}
}
